Resource realm

Keycloak REST Services 1.5.0-Final

Path: / admin / realms / {realm} / clients / {id} / scope-mappings / realm

Get list of realm-level roles associated with this client's scope.

Path parameters:

realm - realm name (not id!)

id - id of client (not client-id)

Sub-Resources

Resources
Name	Description
available	Get list of realm-level roles that are available to attach to this client's scope.
composite	Get all effective realm-level roles that are associated with this client's scope.

Resource Methods

Method Summary
Name	Description
`GET /admin/realms/{realm}/clients/{id}/scope-mappings/realm`	Get list of realm-level roles associated with this client's scope.
`POST /admin/realms/{realm}/clients/{id}/scope-mappings/realm`	Add a set of realm-level roles to the client's scope
`DELETE /admin/realms/{realm}/clients/{id}/scope-mappings/realm`	Remove a set of realm-level roles from the client's scope

Get list of realm-level roles associated with this client's scope.

HTTP Example:: GET /admin/realms/{realm}/clients/{id}/scope-mappings/realm
API Example:: ScopeMappedResource.getRealmScopeMappings({'realm': /* name realm name (not id!) */, 'id': /* id id of client (not client-id) */});
Output:: List<RoleRepresentation> -
Produces:: application/json

Add a set of realm-level roles to the client's scope

HTTP Example:: POST /admin/realms/{realm}/clients/{id}/scope-mappings/realm
API Example:: ScopeMappedResource.addRealmScopeMappings({'realm': /* name realm name (not id!) */, 'id': /* id id of client (not client-id) */, '$entity': /* roles */});
Input:: List<RoleRepresentation>
Output:: void
Consumes:: application/json

Remove a set of realm-level roles from the client's scope

HTTP Example:: DELETE /admin/realms/{realm}/clients/{id}/scope-mappings/realm
API Example:: ScopeMappedResource.deleteRealmScopeMappings({'realm': /* name realm name (not id!) */, 'id': /* id id of client (not client-id) */, '$entity': /* roles */});
Input:: List<RoleRepresentation>
Output:: void
Consumes:: application/json

Keycloak REST Services 1.5.0-Final